Set Transaction Status
AutomatR.OrchestratorActivities.SetTransactionStatus
The "Set Transaction Status" activity in AutomatR OrchestratorActivities is designed for updating the status of a transaction in Orchestrator. This activity facilitates the tracking and monitoring of transaction progress within automation processes.
Properties
| Name | Description |
|---|---|
| Input | |
| Transaction ID | Specifies the ID of the transaction whose status is to be updated. String variables containing the transaction ID. |
| Transaction Status | Specifies the status to be set for the transaction. Options include Success, Failure, Retry, and any additional custom statuses. Enum variables containing the desired status. |
| Custom Data | Enter custom data in dictionary format to associate additional information with the transaction. |
| Replace Custom Data | Select True or False to indicate whether to replace existing custom data with the provided data. If True, existing custom data is replaced; if False, new data is appended. |
| Custom Status Key | Specifies a custom status key to be set for the transaction. |
| Status Message | Specifies a custom status message to provide additional information about the transaction status. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Set Transaction Status" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Status | Outputs the result of the "Set Transaction Status" operation, indicating whether the status update was successful or encountered errors. Boolean variables to store the operation result. |
How to use:
- Drag and drop the "Set Transaction Status" activity onto the workflow.
- Configure the properties by specifying the transaction ID and the desired transaction status.
- Optionally, configure additional parameters such as custom data, custom status key, and status message.
- Execute the workflow to update the status of the specified transaction in Orchestrator.
Example: Consider an example where the "Set Transaction Status" activity is used to update the status of a transaction:
Set Transaction Status:
Transaction ID: "123456"
Transaction Status: Success
Custom Data: { "Key1": "Value1", "Key2": "Value2" }
Replace Custom Data: True
Custom Status Key: "CustomKey"
Status Message: "Transaction processed successfully"
Status: isStatusUpdatedSuccessfully
In this example, the activity updates the status of the transaction with ID "123456" to "Success" and associates custom data, a custom status key, and a status message. The result of the operation (success or failure) is stored in the Boolean variable "isStatusUpdatedSuccessfully" for further handling in the workflow.